| 名称 | 描述 |
|---|---|
| init | 创建和初始化引擎 |
| uninit | 销毁引擎 |
| setBusinessId | 设置业务标识参数 |
| joinRoom | 创建/加入房间：房间不存在时即创建房间；房间存在时即加入这个房间。 |
| setUserVisibility | 设置用户可见性。默认为可见。 |
| leaveRoom | 离开房间。调用此方法离开房间，结束通话过程，释放所有通话相关的资源。 |
| updateToken | 更新 Token |
| setPlaybackVolume | 调节本地播放的所有远端用户混音后的音量 |
| startAudioCapture | 开启内部音频采集。默认为关闭状态。 |
| stopAudioCapture | 关闭内部音频采集。默认为关闭状态。 |
| muteLocalAudio | 控制本地音频流的发送状态：发送/不发送 |
| setAudioVolumeIndicationInterval | 开启/关闭音量提示。默认关闭。 |
| setRemoteAudioPlaybackVolume | 调节来自远端用户的音频播放音量 |
| resumeAllSubscribedStream | 恢复接收来自远端的媒体流 |
| startVideoCapture | 开启内部视频采集。默认为关闭状态 |
| stopVideoCapture | 关闭内部视频采集。默认为关闭状态。 |
| setVideoEncoderConfig | 启动推送多路视频流，设置推送多路流时的各路视频参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 |
| muteLocalVideo | 停止/启动发送本地视频流，默认不发送。 |
| switchCamera | 切换视频内部采集时使用的前置/后置摄像头。默认使用前置摄像头。 |
| setLocalVideoMirrorMode | 设置采用前置摄像头采集时，是否开启镜像模式。 |
| pauseAllSubscribedStream | 暂停接收来自远端的媒体流。 |
| startScreenVideoCapture | 采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，应用窗口中显示的内容，或虚拟屏幕中显示的内容。其中，虚拟屏幕中显示的内容仅在 Windows 平台上支持。 |
| updateScreenCaptureRegion | 更新屏幕共享区域。 |
| UpdateScreenCaptureMouseCursor | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。 |
| updateScreenCaptureHighlightConfig | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。 |
| updateScreenCaptureFilterConfig | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。 |
| stopScreenVideoCapture | 停止屏幕视频流采集。 |
| getScreenCaptureSourceList | 获取屏幕采集对象列表。 |
| getThumbnail | 获取共享对象缩略图 |
| getWindowAppIcon | 获取应用窗体所属应用的图标。 |
| publishScreen | 发布本地屏幕共享流到房间。 |
| unpublishScreen | 停止发布本地屏幕共享流到房间。 |
| setCaptureVolume | 调节音频采集音量 |
| startAudioMixing | 开始播放音乐文件及混音 |
| stopAudioMixing | 停止播放音乐文件及混音 |
| pauseAudioMixing | 暂停播放音乐文件及混音 |
| resumeAudioMixing | 恢复播放音乐文件及混音 |
| setAudioMixingVolume | 调节音乐文件在本地和远端播放的音量大小 |
| getAudioMixingDuration | 获取音乐文件时长 |
| getAudioMixingCurrentPosition | 获取音乐文件播放进度 |
| setAudioMixingPosition | 设置音乐文件的播放位置 |
| preloadAudioMixing | 预加载指定音乐文件到内存中 |
| unloadAudioMixing | 卸载指定音乐文件 |
| enumerateVideoCaptureDevices | 获取当前系统内视频采集设备列表。 |
| setVideoCaptureDevice | 设置当前视频采集设备 |
| getVideoCaptureDevice | 获取当前 SDK 正在使用的视频采集设备信息 |
| enumerateAudioPlaybackDevices | 获取当前系统内音频播放设备列表。如果后续设备有变更，你会收到 OnMediaDeviceStateChanged 回调通知，然后需要重新调用本接口以获得新的设备列表。 |
| enumerateAudioCaptureDevices | 获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。 |
| setAudioPlaybackDevice | 设置音频播放设备。 |
| setAudioCaptureDevice | 设置音频采集设备。 |
| getAudioPlaybackDevice | 获取当前音频播放设备 ID。 |
| getAudioCaptureDevice | 获取当前音频采集设备 ID。 |
| startAudioPlaybackDeviceTest | 启动音频播放设备测试。 该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。 |
| stopAudioPlaybackDeviceTest | 停止音频播放设备测试。 |
| startAudioCaptureDeviceTest | 启动音频采集设备测试。 该方法测试音频采集设备是否能正常工作。启动测试后，会收到 OnAudioVolumeIndication 回调上报的音量信息。 |
| stopAudioCaptureDeviceTest | 停止音频采集设备测试。 |
| setAudioPlaybackDeviceVolume | 设置当前音频播放设备音量 |
| getAudioPlaybackDeviceVolume | 获取当前音频播放设备音量 |
| setAudioCaptureDeviceVolume | 设置当前音频采集设备音量 |
| getAudioCaptureDeviceVolume | 获取当前音频采集设备音量 |
| startAudioDeviceLoopbackTest | 开始音频设备回路测试。 该方法测试音频采集设备和音频播放设备是否能正常工作。一旦测试开始，音频采集设备会采集本地声音，并通过音频播放设备播放出来，同时用户 App 会收到 OnAudioVolumeIndication 回调上报的音量信息。 |
| stopAudioDeviceLoopbackTest | 停止音频设备回路测试。 |
| initAudioPlaybackDeviceForTest | 尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。 |
| initAudioCaptureDeviceForTest | 尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。 |
| setAudioPlaybackDeviceMute | 设置当前音频播放设备静音状态，默认为非静音。 |
| getAudioPlaybackDeviceMute | 获取当前音频播放设备是否静音的信息。 |
| setAudioCaptureDeviceMute | 设置当前音频采集设备静音状态，默认为非静音。 |
| getAudioCaptureDeviceMute | 获取当前音频采集设备是否静音的信息。 |
| setPublishFallbackOption | 设置发布的音视频流回退选项 。 你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流，以保证通话质量。 |
| setSubscribeFallbackOption | 设置订阅的音视频流回退选项。 你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。 |
| setRemoteUserPriority | 设置用户优先级 |
| publish | 在当前房间内手动开始发布本地音视频流 |
| unpublish | 在当前房间内停止发布本地音视频流。 |
| subscribeUserStream | 订阅房间内指定的远端音视频流。 或更新已经订阅的流的属性、媒体类型等配置。 |
| unsubscribe | 停止订阅指定的房间内远端音视频流。无论自动订阅还是手动订阅模式，你都可以调用此方法取消已订阅的音视频流。 |
| sendUserMessage | 给房间内指定的用户发送消息，返回这次发送消息的编号。 调用该函数后会收到一次 userMessageSendResult 回调，告知发送结果。 |
| sendUserBinaryMessage | 给房间内指定的用户发送二进制消息（P2P） |
| setRecordingAudioFrameParameters | 设置本地麦克风录制的音频数据回调参数 |
| setPlaybackAudioFrameParameters | 设置远端所有用户音频数据混音后的音频数据回调参数 |
| setMixedAudioFrameParameters | 设置本地麦克风录制音频数据和远端所有用户音频数据混音后的音频数据回调参数 |
| startFileRecording | 该方法将通话过程中的音视频数据录制到本地的文件中。 |
| stopFileRecording | 停止本地录制 |
| startASR | 开启自动语音识别服务。该方法将识别后的用户语音转化成文字，并通过 OnMessage 事件回调给用户。 |
| stopASR | 关闭语音识别服务 |
| sendRoomMessage | 给房间内所有的用户发送消息。 |
| sendRoomBinaryMessage | 给房间内的所有其他用户发送广播消息。 |
| login | 必须先登录注册一个 uid，才能发送房间外消息和向业务服务器发送消息 |
| logout | 调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。 |
| updateLoginToken | 更新用户用于登录的 Token Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。 调用 login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 OnLoginResult 回调通知，错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。 |
| setServerParams | 设置业务服务器参数 客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给业务服务器之前，必须设置有效签名和业务服务器地址。 |
| getPeerOnlineStatus | 查询对端用户或本端用户的登录状态 |
| SendUserMessageOutsideRoom | 给房间外指定的用户发送文本消息（P2P） |
| getErrorDescription | 获取错误码的描述 |
| sendUserBinaryMessageOutsideRoom | 给房间外指定的用户发送二进制消息（P2P） |
| sendServerMessage | 客户端给业务服务器发送文本消息（P2Server） |
| sendServerBinaryMessage | 客户端给业务服务器发送二进制消息（P2Server） |
| setBackgroundSticker | 设置和开启虚拟背景功能， |
| checkLicense | 视频特效许可证检查 |
| getAuthMessage | 从 CV SDK 获取授权消息，用于获取在线许可证。 |
| enableEffect | 开启关闭视频特效 |
| setAlgoModelPath | 设置视频特效算法模型路径 |
| setEffectNodes | 设置视频特效素材包，支持同时设置多个素材包 |
| updateNode | 设置特效强度 |
| setColorFilter | 设置颜色滤镜 |
| setColorFilterIntensity | 设置已启用颜色滤镜的强度 |
| sendSEIMessage | 在视频通信时，通过视频帧发送 SEI 数据。 |
| setScreenAudioStreamIndex | 在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式 |
| startScreenAudioCapture | 在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频 |
| stopScreenAudioCapture | 在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。 |
| feedback | 本次通话质量打分评价 |
| setEncryptInfo | 设置传输时使用内置加密的方式 |
| startLiveTranscoding | 开启转推直播，并设置合流的视频视图布局和音频属性。 |
| stopLiveTranscoding | 停止转推直播。 |
| updateLiveTranscoding | 更新转推直播参数。 |
| setupLocalVideo | 为本地采集到的视频流绑定本地渲染视图 |
| removeLocalVideo | 解绑本地视频流已绑定的渲染视图 |
| setupRemoteVideo | 为远端视频流绑定本地渲染视图 |
| removeRemoteVideo | 解绑指定远端视频流已绑定的本地视图 |
| removeAllRemoteVideo | 解绑所有已绑定本地视图的指定远端视频流 |
| setupLocalScreen | 为本地屏幕共享流绑定视图 |
| removeLocalScreen | 解绑屏幕共享流已绑定的视图 |
| setupRemoteScreen | 为远端屏幕共享流绑定本地视图 |
| removeRemoteScreen | 解绑远端屏幕共享流已绑定的本地视图 |
| getSDKVersion | 获取当前 SDK 版本信息 |
| getCurrentProcessId | 获取加载引擎进程的 ID 方便调试 |
| 名称 | 描述 |
|---|---|
| OnLocalScreenFrame | 本地屏幕视频流采集成功后，会收到此回调。 |
| OnLocalVideoFrame | 本地视频流数据回调 |
| OnRemoteScreenFrame | 远端屏幕共享流数据回调 |
| OnRemoteVideoFrame | 远端视频数据回调 |
| OnWarning | 当内部发生警告事件时触发该回调 |
| OnError | 当内部发生不可逆转错误时触发该回调 |
| OnAudioMixingFinished | 本地音乐文件播放已结束回调。当调用 startAudioMixing 启动的混音文件播放结束后，会触发该回调。 |
| OnAudioMixingStateChanged | 音频混音文件播放状态改变时回调 |
| OnConnectionStateChanged | SDK 与信令服务器连接状态改变回调。连接状态改变时触发。 |
| OnNetworkTypeChanged | SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 |
| OnPerformanceAlarms | 本地未开启发布性能回退，检测到设备性能不足时，收到此回调。 本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。 |
| OnMediaDeviceStateChanged | 媒体设备事件回调。 |
| OnSysStats | 周期性地发出回调，报告当前cpu与memory使用率 |
| OnJoinRoomResult | 首次加入房间/重连加入房间的回调。此回调表示用户调用 joinRoom 的结果，根据错误码判断成功/失败以及区别是否为重连。 |
| OnLeaveRoom | 离开房间回调。 用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有与通话相关的音视频资源后，通过此回调通知用户离开房间成功。 离开房间后，如果 App 需要使用系统音视频设备，则建议收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备而导致初始化失败。 |
| OnRoomWarning | SDK 发生警告回调。 SDK 内部遇到可恢复错误时，在尝试自动恢复的同时，会通过此回调通知用户。此回调事件仅用作通知。 |
| OnRoomError | SDK 发生错误回调。 SDK 内部遇到不可恢复错误时，会通过此回调通知 App，需要 App 根据错误码进行操作或提示用户。 |
| OnAudioVolumeIndication | 提示房间内谁正在说话以及说话者音量的回调 |
| OnRoomStats | 用户加入房间成功后，每 2s 会收到一次房间内统计信息的回调。 |
| OnLocalStreamStats | 反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调，每 2s 触发一次。 |
| OnRemoteStreamStats | 通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况，每 2s 触发一次。 |
| OnUserJoined | 远端用户加入房间回调。 |
| OnUserLeave | 远端用户离开房间回调。 |
| OnUserMuteAudio | 房间内某用户调用 muteLocalAudio ,改变本地音频发送状态时，房间内其他用户会收到此回调。 |
| OnUserMuteVideo | 房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。参看 muteLocalVideo 。 |
| OnUserStartAudioCapture | 房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。 |
| OnUserStopAudioCapture | 房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。 |
| OnFirstLocalAudioFrame | 本地采集到第一帧音频帧时，收到该回调 |
| OnFirstRemoteAudioFrame | 接收到来自远端某音频流的第一帧时，收到该回调。 |
| OnStreamRemove | 房间内远端流移除回调。 房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。 |
| OnStreamAdd | 房间内新流发布回调。 房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。 |
| OnSimulcastSubscribeFallback | 因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。 |
| OnFirstLocalVideoFrameCaptured | 第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。 |
| OnLocalVideoSizeChanged | 本地视频大小或旋转配置发生改变时，收到此回调。 |
| OnRemoteVideoSizeChanged | 远端视频大小或旋转配置发生改变时，房间内订阅此视频流的用户会收到此回调。 |
| OnFirstRemoteVideoFrameRendered | 第一帧远端视频流在视图上渲染成功后，收到此回调。 |
| OnUserStartVideoCapture | 房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。 |
| OnUserStopVideoCapture | 房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。 |
| OnLocalAudioStateChanged | 本地音频的状态发生改变时，该回调通知当前的本地音频状态。 |
| OnRemoteAudioStateChanged | 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。 |
| OnLocalVideoStateChanged | 本地视频流的状态发生改变时，收到该事件。 |
| OnRemoteVideoStateChanged | 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。 |
| OnAudioFrameSendStateChanged | 音频首帧发送状态改变回调 |
| OnVideoFrameSendStateChanged | 视频首帧发送状态改变回调 |
| OnScreenVideoFrameSendStateChanged | 屏幕共享流视频首帧发送状态改变回调 |
| OnAudioFramePlayStateChanged | 音频首帧播放状态改变回调 |
| OnVideoFramePlayStateChanged | 视频首帧播放状态改变回调 |
| OnScreenVideoFramePlayStateChanged | 屏幕共享流视频首帧播放状态改变回调 |
| OnUserEnableLocalAudio | 远端用户开启/关闭音频设备采集时，房间内其他人会收到这个回调。 该回调由远端用户调用 enableLocalAudio 方法触发。 |
| OnRoomMessageReceived | 接收到房间内广播消息的回调。 |
| OnUserEnableLocalVideo | 远端用户开启/关闭本地视频采集时回调该事件，当远端用户调用 enableLocalVideo 时，其他用户会触发此回调。 |
| OnRoomMessageSendResult | 当调用 sendMessageToRoom 函数发送消息后，回调此条消息的发送结果（反馈）。 |
| OnRoomBinaryMessageReceived | 接收到房间内二进制广播消息的回调。 |
| OnUserMessageReceived | 点对点消息回调。接收到同一房间内 uid 所属用户发来消息时触发。 |
| OnUserMessageSendResult | 当调用 sendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。 |
| OnUserBinaryMessageReceived | 单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。 |
| OnSEIMessageReceived | 收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调 |
| OnStreamMixingEvent | 通知转推直播关键事件 |
| OnStreamMixingVideoFrame | 合流视频帧回调 |
| OnRecordingStateUpdate | 获取本地录制状态回调。 该回调由 startFileRecording 或 StopFileRecording 触发。 |
| OnRecordingProgressUpdate | 本地录制进度回调。 该回调由 StartFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。 |
| OnLoginResult | 登录结果回调 |
| OnLogout | 登出结果回调 |
| OnServerParamsSetResult | 设置业务服务器参数的返回结果 |
| OnGetPeerOnlineStatus | 查询对端或本端用户登录状态的返回结果 |
| OnUserMessageReceivedOutsideRoom | 收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调 |
| OnUserBinaryMessageReceivedOutsideRoom | 收到房间外用户调用 SendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调 |
| OnUserMessageSendResultOutsideRoom | 给房间外指定的用户发送消息的回调 |
| OnServerMessageSendResult | 给业务服务器发送消息的回调 |
| OnRecordAudioFrame | 返回麦克风录制的音频数据 |
| OnPlaybackAudioFrame | 返回远端所有用户混音后的音频数据 |
| OnMixedAudioFrame | 返回本地麦克风录制和远端所有用户混音后的音频数据 |
| OnASRSuccess | 语音识别服务开启成功回调 |
| OnMessage | 语音转文字成功回调，该回调返回识别后的全量消息。 |
| OnASRError | 当语音识别服务内部发生错误事件时触发该回调。 |
| OnLiveTranscodingResult | 直播推流转码错误回调。 用户调用 startLiveTranscoding 接口启动直播推流转码功能后，启动结果和推流过程中 的错误均会通过此回调方法通知用户。 |